Export
Export image
Node Data | |
---|---|
IoCompose | |
Display name | |
Export | |
Internal name | |
Node_Export | |
Inheritances | |
node | |
node_export | |
Inputs | |
node_export | |
surface |
Surface |
path |
Paths |
text |
Template |
enum |
Type |
int |
Template Guides |
bool |
Loop |
bool |
Frame Optimization |
float |
Color Merge |
int |
Framerate |
enum |
Format |
float |
Quality |
int |
Sequence Begin |
slider |
Frame Range |
enum |
Subformat |
int |
Frame Step |
bool |
Custom Range |
bool |
Export On Save |
Outputs | |
node_export | |
surface |
Preview |
Export node is one of the most important node in Pixel Composer. It allows you to export surface to different formats, it also allows Pixel Composer project to be run in headless mode.
Output Format
There're 3 types of output:
Type | Description | Format |
---|---|---|
Single Image | Export still surface to image file | .png, .jpg, .webp |
Image Sequence | Export the entire animation into series of still images | .png, .jpg, .webp |
Animation | Export the animation into a animation file | .gif, .apng, .mp4, .webm |
Export Path
The exported file location is control by Paths. However, you can add extra formatting using Template.
Export Template
Template is used with a defined Paths. Template will replace special token with the actual value in
the Paths.
The available tokens are:
Token | Description |
---|---|
%d | Path directory, the folder where the path is located |
%{number}d | Getting the parent folder, the {number} control how many parent to go up |
%n | File name |
%f | Frame number, use with image sequence export |
%{number}f | Frame number, with zero padding to 2 digits |
%i | Array index, use when exporting surface array |
For example, if the Paths is set to foo/bar/file.png then these templates will returns:
Template | Result |
---|---|
%d%n | foo/bar/file |
%1dname | foo/name |
Note that the extension will be remove and re-added automatically based on the selecting Format.
Format Properties
.png
.png format comes with extra Subformat for file optimization.
Subformat | Description |
---|---|
PNG32 | Default 32 bit PNG format |
INDEX4 | 4 bit indexed PNG format |
INDEX8 | 8 bit indexed PNG format |
.jpg
.jpg format comes with Quality, the lower the quality, the smaller the file size.
.gif
.gif comes with Frame Optimization for reducing file size and Color Merge that combine similiar into one for even smaller file.
.mp4
.mp4 file has Quality (crf value) slider for controlling quality of the output. The higher the CRF value, the lower the quality.
Animation Properties
For animation type, there're extra properties for controlling the animation.
Property | Description |
---|---|
Framerate | The speed of the animation |
Frame Step | Export one frame every n frames step |
Frame Range | Range of the animation to export |
Loop | Loop the animation |